//! My Crate
//!
//! 'my_crate' is a collection of utilities to make performing certain calculations more convenient
//!

/// 给一个数加1
///
/// # Example
///
/// ```
/// let number = 1;
///
/// assert_eq!(2, mylib::add_one(number));
/// ```
pub fn add_one(x: i32) -> i32 {
  return x + 1;
}

// `///` 是给文档做注释, 支持Markdown语法
// 常用的章节 除了 Example、 还有：
// - Panics: 函数可能发生 panic 的场景
// - Errors: 如果函数返回 Result, 描述可能的错误种类, 以及可导致错误的条件
// - Safety: 如果函数处于 unsafe 调用, 就应该解释函数 unsafe 的原因, 以及调用者确保的使用前提

// `//!` 是用来注释 包裹该注释的 外层条目的

// #[cfg(test)]
// mod tests {
//     #[test]
//     fn it_works() {
//         assert_eq!(2 + 2, 4);
//     }
// }
